[NOQA] fix: performance analytics markers #51815

adhorodyski · 2024-10-31T16:57:48Z

Explanation of Change

This PR corrects performance markers (both local & reporting to Firebase) in their docs as well as the implementation. Goal is to have clear definitions and be able to correctly collect performance data from full user interactions.

Fixed Issues

$ #51742
PROPOSAL: https://expensify.slack.com/archives/C05LX9D6E07/p1730214849510819

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

src/libs/E2E/tests/linkingTest.e2e.ts

src/libs/E2E/tests/chatOpeningTest.e2e.ts

src/libs/E2E/tests/linkingTest.e2e.ts

melvin-bot · 2024-11-08T16:51:43Z

@hoangzinh Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

hoangzinh · 2024-11-09T04:51:37Z

Hey @mountiny do we need a C+ for this PR?

mountiny

LGTM but waiting to confirm the e2e tests will work fine with all these changes

src/libs/E2E/tests/linkingTest.e2e.ts

mountiny · 2024-11-10T23:52:02Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

blazejkustra

LGTM

kirillzyusko · 2024-11-12T12:07:58Z

I could run e2e tests successfully (in dev mode - that's why baseline and delta results are identical). Below are results:

Name	Duration
App start time nativeLaunchEnd_To_appCreationStart	213.188 ms → 213.188 ms
App start time nativeLaunch	636.375 ms → 636.375 ms
App start time appCreationEnd_To_contentAppeared	4319.933 ms → 4319.933 ms
App start time contentAppeared_To_screenTTI	2535.162 ms → 2535.162 ms
App start time appCreation	340.938 ms → 340.938 ms
App start time jsBundleDownload	1256.313 ms → 1256.313 ms
App start time TTI	8016.331 ms → 8016.331 ms
App start time regularAppStart	0.340 ms → 0.340 ms
App start time runJsBundle	2434.733 ms → 2434.733 ms
App start time (CPU)	122.729 % → 122.729 %
App start time (FPS)	50.301 FPS → 50.301 FPS
App start time (RAM)	535.726 MB → 535.726 MB
App start time (CPU/JS)	58.700 % → 58.700 %
App start time (CPU/UI)	22.307 % → 22.307 %
Open search router TTI Load Search Options	103.367 ms → 103.367 ms
Open search router TTI Open Search Router TTI	640.332 ms → 640.332 ms
Open search router TTI (CPU)	121.977 % → 121.977 %
Open search router TTI (FPS)	50.437 FPS → 50.437 FPS
Open search router TTI (RAM)	539.509 MB → 539.509 MB
Open search router TTI (CPU/JS)	57.487 % → 57.487 %
Open search router TTI (CPU/UI)	23.920 % → 23.920 %
Report typing Composer typing rerender count	1.000 renders → 1.000 renders
Report typing Message sent	588.871 ms → 588.871 ms
Report typing (CPU)	131.267 % → 131.267 %
Report typing (FPS)	52.008 FPS → 52.008 FPS
Report typing (RAM)	627.457 MB → 627.457 MB
Report typing (CPU/JS)	54.462 % → 54.462 %
Report typing (CPU/UI)	24.194 % → 24.194 %
Chat opening Chat TTI	793.207 ms → 793.207 ms
Chat opening (CPU)	123.160 % → 123.160 %
Chat opening (FPS)	50.667 FPS → 50.667 FPS
Chat opening (RAM)	553.404 MB → 553.404 MB
Chat opening (CPU/JS)	60.288 % → 60.288 %
Chat opening (CPU/UI)	22.733 % → 22.733 %
Linking	1452.700 ms → 1452.700 ms
Linking (CPU)	128.259 % → 128.259 %
Linking (FPS)	51.749 FPS → 51.749 FPS
Linking (RAM)	595.603 MB → 595.603 MB
Linking (CPU/JS)	65.580 % → 65.580 %
Linking (CPU/UI)	22.667 % → 22.667 %

kirillzyusko · 2024-11-12T12:09:18Z

@hannojg can you also review these changes? 👀

adhorodyski · 2024-11-12T13:29:29Z

@mountiny should we worry about these eslint checks here? This is an error on withOnyx deprecation.

/home/runner/work/App/App/src/pages/home/sidebar/SidebarLinksData.tsx
  77:16  error  'withOnyx' is deprecated. Use `useOnyx` instead of `withOnyx` whenever possible.

adhorodyski · 2024-11-12T13:50:34Z

I think I missed the updated sidebar_loaded end event, updating this shortly before we merge anything.

adhorodyski · 2024-11-12T14:06:15Z

Updated with the new sidebar_loaded end event placement, here's a before/after. @kirillzyusko could you please rerun the e2e suite on your end? It's a pretty crucial trigger so I don't want to mess it up 😅 Thanks!

Also, this one is not being reported to Firebase with this PR. Should we do it? It doesn't provide us with a full TTI measure (I will follow up with this one), but gives a sense of how long the LHN itself takes to load for people.

tti.after.mov

hannojg · 2024-11-12T14:43:11Z

Yes, if the e2e tests are still working this LGTM!

mountiny · 2024-11-12T16:32:15Z

@adhorodyski no need to worry about the eslint

And we can add it, I dont think its any harm in adding these, worst case we decide later its not useful and we stop using it

mountiny

Thanks, seems like we are good to go, right?

src/libs/E2E/tests/linkingTest.e2e.ts

…er_options events

This reverts commit f50765a.

…ssage

mountiny · 2024-11-12T17:43:49Z

Not changing the useOnyx everywhere in this PR

melvin-bot · 2024-11-12T17:43:58Z

@mountiny looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

mountiny · 2024-11-12T17:46:10Z

Explained above

OSBotify · 2024-11-12T17:54:20Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2024-11-13T01:08:43Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.61-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	success ✅

github-actions · 2024-11-14T00:40:01Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.61-3 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

adhorodyski mentioned this pull request Oct 31, 2024

[HOLD for payment 2024-11-29] [HOLD for payment 2024-11-21] Align Firebase performance metrics with core in-app workflows #51742

Closed

adhorodyski changed the title ~~fix: performance analytics markers~~ [WIP] fix: performance analytics markers Oct 31, 2024

adhorodyski commented Nov 5, 2024

View reviewed changes

src/libs/E2E/tests/linkingTest.e2e.ts Show resolved Hide resolved

adhorodyski commented Nov 5, 2024

View reviewed changes

src/libs/E2E/tests/linkingTest.e2e.ts Show resolved Hide resolved

adhorodyski mentioned this pull request Nov 5, 2024

[HOLD for payment 2024-12-17] [HOLD for payment 2024-12-16] [HOLD for payment 2024-10-30] [HOLD for payment 2024-10-29] Benchmark performance bottlenecks when opening chats #50652

Open

kirillzyusko reviewed Nov 6, 2024

View reviewed changes

src/libs/E2E/tests/chatOpeningTest.e2e.ts Show resolved Hide resolved

adhorodyski commented Nov 8, 2024

View reviewed changes

src/libs/E2E/tests/linkingTest.e2e.ts Show resolved Hide resolved

adhorodyski changed the title ~~[WIP] fix: performance analytics markers~~ [NOQA] fix: performance analytics markers Nov 8, 2024

adhorodyski marked this pull request as ready for review November 8, 2024 16:51

adhorodyski requested a review from a team as a code owner November 8, 2024 16:51

melvin-bot bot requested review from hoangzinh and removed request for a team November 8, 2024 16:51

mountiny self-requested a review November 8, 2024 17:06

mountiny assigned adhorodyski Nov 8, 2024

mountiny removed the request for review from hoangzinh November 10, 2024 23:48

mountiny previously approved these changes Nov 10, 2024

View reviewed changes

src/libs/E2E/tests/linkingTest.e2e.ts Show resolved Hide resolved

blazejkustra approved these changes Nov 12, 2024

View reviewed changes

adhorodyski force-pushed the feat/perf-analytics-markers branch from 2218aa7 to ff5f18d Compare November 12, 2024 12:40

adhorodyski dismissed mountiny’s stale review via 360e7c5 November 12, 2024 14:02

mountiny approved these changes Nov 12, 2024

View reviewed changes

src/libs/E2E/tests/linkingTest.e2e.ts Show resolved Hide resolved

adhorodyski added 15 commits November 12, 2024 18:01

feat: update docs & impl for the open_search event

5f27a44

docs: update descriptions for the search_filter_options and load_filt…

c7a661a

…er_options events

Revert "chore: remove the sidebar_loaded event"

c1a0d42

This reverts commit f50765a.

fix: imports

0d3cf61

chore: clear imports linter checks

2e7f51a

chore: rm redundant promise unwrap for removed chat_render

8c3da54

fix: linking test for chats

ee03b3d

chore: empty line

903f2c4

feat: do not start the sidebar_loaded event

82d58be

chore: rm redundant timing module import

b0cc392

fix: linking test assertion scenario

eb7f2db

feat: add missing performance markers, rename message_sent to send_me…

291dc29

…ssage

chore: rm redundant timing module import

669e3a0

docs: rename message_sent to send_message

216db09

fix: sidebar_loaded end event trigger & docs

11ff391

adhorodyski force-pushed the feat/perf-analytics-markers branch from 360e7c5 to 11ff391 Compare November 12, 2024 17:01

Merge branch 'Expensify:main' into feat/perf-analytics-markers

41978b1

mountiny approved these changes Nov 12, 2024

View reviewed changes

mountiny merged commit f338d04 into Expensify:main Nov 12, 2024
16 of 17 checks passed

melvin-bot bot added the Emergency label Nov 12, 2024

mountiny removed the Emergency label Nov 12, 2024

adhorodyski deleted the feat/perf-analytics-markers branch November 12, 2024 18:04

This was referenced Nov 12, 2024

Investigate workflow job failing on main: e2ePerformanceTests / Run E2E tests in AWS device farm #52419

Closed

Deploy Checklist: New Expensify 2024-11-13 #52440

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NOQA] fix: performance analytics markers #51815

[NOQA] fix: performance analytics markers #51815

adhorodyski commented Oct 31, 2024 •

edited

Loading

melvin-bot bot commented Nov 8, 2024

hoangzinh commented Nov 9, 2024

mountiny left a comment

mountiny commented Nov 10, 2024 •

edited

Loading

blazejkustra left a comment

kirillzyusko commented Nov 12, 2024

kirillzyusko commented Nov 12, 2024

adhorodyski commented Nov 12, 2024

adhorodyski commented Nov 12, 2024

adhorodyski commented Nov 12, 2024 •

edited

Loading

hannojg commented Nov 12, 2024

mountiny commented Nov 12, 2024

mountiny left a comment

mountiny commented Nov 12, 2024

melvin-bot bot commented Nov 12, 2024

mountiny commented Nov 12, 2024

OSBotify commented Nov 12, 2024

github-actions bot commented Nov 13, 2024

github-actions bot commented Nov 14, 2024

[NOQA] fix: performance analytics markers #51815

[NOQA] fix: performance analytics markers #51815

Conversation

adhorodyski commented Oct 31, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 8, 2024

hoangzinh commented Nov 9, 2024

mountiny left a comment

Choose a reason for hiding this comment

mountiny commented Nov 10, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

blazejkustra left a comment

Choose a reason for hiding this comment

kirillzyusko commented Nov 12, 2024

kirillzyusko commented Nov 12, 2024

adhorodyski commented Nov 12, 2024

adhorodyski commented Nov 12, 2024

adhorodyski commented Nov 12, 2024 • edited Loading

hannojg commented Nov 12, 2024

mountiny commented Nov 12, 2024

mountiny left a comment

Choose a reason for hiding this comment

mountiny commented Nov 12, 2024

melvin-bot bot commented Nov 12, 2024

mountiny commented Nov 12, 2024

OSBotify commented Nov 12, 2024

github-actions bot commented Nov 13, 2024

github-actions bot commented Nov 14, 2024

adhorodyski commented Oct 31, 2024 •

edited

Loading

mountiny commented Nov 10, 2024 •

edited

Loading

adhorodyski commented Nov 12, 2024 •

edited

Loading